Request a report based on Job Number Schema
api_request Element
Description
starts a connection request.
Namespace (none)
Diagram
includecustom Element msg_type Element job_num Element password Element username Element action Element Sequence api_request Element
Overview
api_request
starts a connection request.
Sequence
action xs:string

One of nine action types.  This lets us know the type of connection you wish to make and what you need the API to do for you. In the case of requesting a job report, the action type is "report".

username xs:string
The username of this user as stored on the PRODOCOM system. You will need to get this information from PRODOCOM before you attempt any form of API connection.  Typically the username is PRODOCOM website login.
password xs:string
The password of this user as stored on the PRODOCOM system. You will need to get this information from PRODOCOM before you attempt any form of API connection.
job_num xs:string
This is the number that the PRODOCOM production system uses to identify a specific job.  This will be an 8 digit alpha numeric field and is used to identify a particular job.  The job_num can also be used in the PRODOCOM web portal to locate a job in the reporting option.
msg_type xs:string

Used for finding a job in the appropriate PRODOCOM messaging system.  The three systems are;

      outbound for messages sent via "API" or "Quick send" on PRODOCOM web portal.

      inbound for inbound fax or SMS messages.

      campaigns for messages sent via the campaigns section of the PRODOCOM web portal.

includecustom xs:string
This is an optional field if you wish the request to return all additional custom fields in the recipient details.
Source
<xs:element name="api_request" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:sequence>
      <xs:element type="xs:string" name="action" />
      <xs:element type="xs:string" name="username" />
      <xs:element type="xs:string" name="password" />
      <xs:element type="xs:string" name="job_num" />
      <xs:element type="xs:string" name="msg_type" />
      <xs:element type="xs:string" name="includecustom" />
    </xs:sequence>
  </xs:complexType>
</xs:element>
See Also
Request a report based on Job Number Schema

 

 


© 2013 All Rights Reserved.

Send comments on this topic.